Show diagnostics popup when hovering over gutter icons #2349
Conversation
jwortmann
force-pushed
the
diagnostics-icons-hover
branch
from
83f3faa
to
6ab2241
Compare
jwortmann
force-pushed
the
diagnostics-icons-hover
branch
from
6ab2241
to
c38f287
Compare
plugin/documents.py
Outdated
| content = '' | ||
| if self._lightbulb_line == self.view.rowcol(point)[0]: | ||
| content += code_actions_content(self._actions_by_config) | ||
| if userprefs().diagnostics_gutter_marker and userprefs().show_diagnostics_severity_level: |
There was a problem hiding this comment.
Is this the expected behavior?
1
"diagnostics_gutter_marker": "circle",
If there are 2 diagnostics,
and diagnostics_gutter_marker is set to "circle"
display the diagnostics on gutter hover.
2
"diagnostics_gutter_marker": "",
If there are 2 diagnostics,
and diagnostics_gutter_marker is set to ""
don't display the diagnostics on gutter hover.
There was a problem hiding this comment.
In case 2 it doesn't show the diagnostics in addition to the code actions, because in general they can be unrelated to each other. But I'm not sure, maybe would be better to also see the diagnostics, what do you think? In that case it should probably only filter for the diagnostics which are overlapping the current caret position or selection.
There was a problem hiding this comment.
If I did it correctly, then the popup in your example 2 should show only the first diagnostic with small "d" now (where the caret is).
There was a problem hiding this comment.
If I did it correctly, then the popup in your example 2 should show only the first diagnostic with small "d" now (where the caret is).
That is correct.
I will see the diagnotics where the cursor is if I hover the gutter.
But I am not sure I think that behavior is the best choice,
because I can already hover with the cursor over the diagnostics and see the diagnostic.
So it is kind of redudant.
it should probably only filter for the diagnostics which are overlapping the current caret position or selection.
For me it would be more intuitive
if hovering the gutter should show all diagnostics that just exist on the line. (not based on cursor or selection)
So my expected behavior would be the following:
if "diagnostics_gutter_marker": ""
If there are 2 diagnostics,
display the 2 diagnostics on gutter hover.
There was a problem hiding this comment.
But I am not sure I think that behavior is the best choice,
because I can already hover with the cursor over the diagnostics and see the diagnostic.
So it is kind of redudant.
In this case with the diagnostic icons disabled it will show only the diagnostic(s) which is/are sent as part of the code action request (CodeActionContext). So there is a good chance that the code actions are related to the diagnostics at the cursor position, especially because we only show Quick Fix actions here. And the code actions request is sent for a particular range, so the actions should also be only applicable for the current cursor position.
You could consider the diagnostic from this screenshot to be part of the lightbulb hover, and the other diagnostics on the line or on different lines are not shown because the diagnostics gutter icons are disabled. I think it makes sense.
And I would not say that it is redundant, it's rather just a different way to see the diagnostic message. For example I have the code actions in the regular hover popup disabled, so I will never see them if I hover over the error underline.
This will show a popup with all diagnostics from the line (except hint severity), sorted by severity, when you hover over a gutter icon. It is compatible with the code actions popup if applicable for the current caret position and using the "bulb" setting.